chore(sdk): [NET-1462] StreamrClient#searchStreams() queries using Stream entity
#3132
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
teogeb
changed the title
StreamrClient#searchStreams() queries using Stream entityStreamrClient#searchStreams() queries using Stream entity
teogeb
added a commit
to streamr-dev/network-contracts
that referenced
this pull request
May 23, 2025
Added new field to `Stream` entity: `Stream#idAsString`. It has same value as in the `id` field. The field allows us do to substring queries for the field id (by using `idAsString_contains` where clause). This feature is needed e.g. in streamr-dev/network#3132.
…reamPermission entitity
teogeb
added a commit
to streamr-dev/network-contracts
that referenced
this pull request
Jun 17, 2025
Added new field to `Stream` entity: `Stream#idAsString`. It has same value as in the `id` field. The field allows us to do substring queries for the field id (by using `idAsString_contains` where clause). This feature is needed e.g. in streamr-dev/network#3132.
teogeb
changed the title
StreamrClient#searchStreams() queries using Stream entityStreamrClient#searchStreams() queries using Stream entity
There was a problem hiding this comment.
Pull Request Overview
This PR optimizes the searchStreams functionality in the SDK by switching the GraphQL queries from using the StreamPermission entity to the Stream entity directly, resulting in simpler queries and significant performance improvements.
- Refactored query building in searchStreams to use inline where clauses.
- Updated the SearchStreamsResultItem interface and related transformations in the StreamRegistry.
- Removed the unused createWhereClause utility in TheGraphClient.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/utils/src/TheGraphClient.ts | Removed the obsolete createWhereClause function. |
| packages/sdk/src/contracts/searchStreams.ts | Refactored the query to use the Stream entity directly and updated filter logic. |
| packages/sdk/src/contracts/StreamRegistry.ts | Adjusted response processing to match the new stream query structure. |
| CHANGELOG.md | Updated changelog with a reference to the optimization PR. |
Comments suppressed due to low confidence (1)
packages/sdk/src/contracts/searchStreams.ts:16
- The SearchStreamsResultItem interface still defines a 'permissions' field even though the updated GraphQL query only returns 'id' and 'metadata'. Consider updating or removing the 'permissions' field to reflect the actual response data.
export interface SearchStreamsResultItem {
harbu
approved these changes
Jun 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changed the
StreamrClient#searchStreams()to useStreamentity directly. The previous implementation used theStreamPermissionentity, which made the queries more complex and slower. See benchmarks below.This also fixes a potential bug as the previous implementation relied on the contents of
StreamPermission#idto be prefixed with stream id. Most or all of the IDs in our subgraphs have used that kind of id format, but it is not a documented feature of the subgraphs.Benchmarks
The benchmarks were run in
dev2environment which had ~10000 streamsRelated changes
Removed obsolete
createWhereClause()method fromTheGraphClient.